printer.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef PRINTER_H
#define PRINTER_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define PRINTER_CMD_EOT                 0x04
#define PRINTER_CMD_ENQ                 0x05
#define PRINTER_CMD_HT                  0x09
#define PRINTER_CMD_LF                  0x0A
#define PRINTER_CMD_CR                  0x0D
#define PRINTER_CMD_DLE                 0x10
#define PRINTER_CMD_DC4                 0x14
#define PRINTER_CMD_ESC                 0x1B
#define PRINTER_CMD_FS                  0x1C
#define PRINTER_CMD_GS                  0x1D

#define PRINTER_COM_BAUD_RATE_9600      0x00
#define PRINTER_COM_BAUD_RATE_19200     0x01
#define PRINTER_COM_BAUD_RATE_38400     0x02
#define PRINTER_COM_BAUD_RATE_57600     0x03
#define PRINTER_COM_BAUD_RATE_115200    0x04
#define PRINTER_COM_FLOW_CTRL_OFF       0x00
#define PRINTER_COM_FLOW_CTRL_SW        0x01
#define PRINTER_COM_FLOW_CTRL_HW        0x02

#define PRINTER_HEAD_MM58_FTP628MCL101  0x00
#define PRINTER_HEAD_MM80_FTP638MCL101  0x01
#define PRINTER_HEAD_MM58_LTP02_245_13  0x02
#define PRINTER_HEAD_MM58_LTP02_245_C1  0x03

#define PRINTER_FONT_TYPE_NORMAL        0x00
#define PRINTER_FONT_TYPE_ITALIC        0x02
#define PRINTER_FONT_TYPE_BOLD          0x08
#define PRINTER_FONT_TYPE_DOUBLE_HEIGHT 0x10
#define PRINTER_FONT_TYPE_DOUBLE_WIDTH  0x20
#define PRINTER_FONT_TYPE_REVERSE       0x40
#define PRINTER_FONT_TYPE_UNDERLINE     0x80

#define PRINTER_FONT_SIZE_SMALL         0x01
#define PRINTER_FONT_SIZE_LARGE         0x02

#define PRINTER_ALIGN_LEFT              0x00
#define PRINTER_ALIGN_CENTER            0x01
#define PRINTER_ALIGN_RIGHT             0x02

#define PRINTER_GRAYSCALE_0             0x00
#define PRINTER_GRAYSCALE_1             0x01
#define PRINTER_GRAYSCALE_2             0x02
#define PRINTER_GRAYSCALE_3             0x03
#define PRINTER_GRAYSCALE_4             0x04
#define PRINTER_GRAYSCALE_5             0x05
#define PRINTER_GRAYSCALE_6             0x06
#define PRINTER_GRAYSCALE_7             0x07
#define PRINTER_GRAYSCALE_8             0x08

#define PRINTER_PICTURE_TYPE_NORMAL     0x00

#define PRINTER_BARCODE_SYS_UPCA        0x00
#define PRINTER_BARCODE_SYS_UPCE        0x01
#define PRINTER_BARCODE_SYS_EAN13       0x02
#define PRINTER_BARCODE_SYS_EAN8        0x03
#define PRINTER_BARCODE_SYS_CODE39      0x04
#define PRINTER_BARCODE_SYS_ITF25       0x05
#define PRINTER_BARCODE_SYS_CODABAR     0x06
#define PRINTER_BARCODE_SYS_CODE93      0x07
#define PRINTER_BARCODE_SYS_CODE128     0x08

#define PRINTER_CB_STATE_DEFAULT        0x00
#define PRINTER_CB_STATE_PAPEROUT       0x04
#define PRINTER_CB_STATE_OVERHEAT       0x08

#define PRINTER_BITMAP_LOCATION_1       0x01
#define PRINTER_BITMAP_LOCATION_2       0x02
#define PRINTER_BITMAP_LOCATION_3       0x03
#define PRINTER_BITMAP_LOCATION_4       0x04
#define PRINTER_BITMAP_ALIGN            0x00
#define PRINTER_BITMAP_MODE_NORMAL      0x00

#define PRINTER_QR_SIZE_21_53           0x00
#define PRINTER_QR_SIZE_57_121          0x01
#define PRINTER_QR_SIZE_125_177         0x02
#define PRINTER_QR_ERROR_7_PCT          0x00
#define PRINTER_QR_ERROR_15_PCT         0x01
#define PRINTER_QR_ERROR_25_PCT         0x02
#define PRINTER_QR_ERROR_30_PCT         0x03

#define PRINTER_READY_TIMEOUT           5000

#define PRINTER_TX_DRV_BUFFER_SIZE      500
#define PRINTER_RX_DRV_BUFFER_SIZE      100
 // printer_cmd



#define PRINTER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // printer_map // printer

typedef struct
{
    // Input pins
    digital_in_t rts;               
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ PRINTER_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ PRINTER_TX_DRV_BUFFER_SIZE ];  
 
    uint8_t status[ 16 ];           
    uint8_t fw_info[ 64 ];          
 
} printer_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t rts;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} printer_cfg_t;

typedef enum
{
    PRINTER_OK = 0,
    PRINTER_ERROR = -1
 
} printer_return_value_t;


void printer_cfg_setup ( printer_cfg_t *cfg );

err_t printer_init ( printer_t *ctx, printer_cfg_t *cfg );

err_t printer_default_cfg ( printer_t *ctx );

err_t printer_generic_write ( printer_t *ctx, uint8_t *data_in, uint32_t len );

err_t printer_generic_read ( printer_t *ctx, uint8_t *data_out, uint8_t len );

uint8_t printer_get_rts_pin ( printer_t *ctx );

err_t printer_get_status ( printer_t *ctx );

err_t printer_get_fw_info ( printer_t *ctx );

err_t printer_set_com_mode ( printer_t *ctx, uint8_t baud_rate, uint8_t flow_control );

err_t printer_set_printer_head ( printer_t *ctx, uint8_t head_index );

err_t printer_soft_init ( printer_t *ctx );

err_t printer_print_lf ( printer_t *ctx );

err_t printer_print_cr ( printer_t *ctx );

err_t printer_print_string ( printer_t *ctx, char *data_in );

err_t printer_print_string_lf ( printer_t *ctx, char *data_in );

err_t printer_print_dots ( printer_t *ctx, uint8_t num_dots );

err_t printer_print_lines ( printer_t *ctx, uint8_t num_lines );

err_t printer_set_font_type ( printer_t *ctx, uint8_t font_type );

err_t printer_set_alignment ( printer_t *ctx, uint8_t align );

err_t printer_set_line_spacing ( printer_t *ctx, uint8_t num_dots );

err_t printer_default_line_spacing ( printer_t *ctx );

err_t printer_set_horizontal_tab ( printer_t *ctx, uint8_t *col_pos, uint8_t num_tabs );

err_t printer_horizontal_tab ( printer_t *ctx );

err_t printer_print_picture ( printer_t *ctx, uint8_t *pic_buf, uint16_t h_size, uint16_t v_size );

err_t printer_set_left_margin ( printer_t *ctx, uint8_t num_dots );

err_t printer_set_right_margin ( printer_t *ctx, uint8_t num_dots );

err_t printer_set_abs_print_pos ( printer_t *ctx, uint16_t num_dots );

err_t printer_set_font_grayscale ( printer_t *ctx, uint8_t grayscale );

err_t printer_set_db_mode ( printer_t *ctx );

err_t printer_cancel_db_mode ( printer_t *ctx );

err_t printer_set_font_size ( printer_t *ctx, uint8_t size );

err_t printer_hide_barcode_text ( printer_t *ctx );

err_t printer_show_barcode_text ( printer_t *ctx );

err_t printer_set_barcode_height ( printer_t *ctx, uint8_t height );

err_t printer_set_barcode_width ( printer_t *ctx, uint8_t width );

err_t printer_print_barcode ( printer_t *ctx, uint8_t barcode_sys, uint8_t *barcode, uint8_t barcode_len );

err_t printer_clear_print_buffer ( printer_t *ctx );

err_t printer_set_printer_cb ( printer_t *ctx, uint8_t callback );

err_t printer_download_nv_bitmap ( printer_t *ctx, uint8_t location, uint8_t h_size, uint8_t v_size, uint8_t *bitmap );

err_t printer_print_nv_bitmap ( printer_t *ctx, uint8_t location );

err_t printer_set_qr_size ( printer_t *ctx, uint8_t size );

err_t printer_set_qr_error_corr ( printer_t *ctx, uint8_t corr_level );

err_t printer_transfer_qr_code ( printer_t *ctx, uint8_t *qr_code, uint16_t code_len );

err_t printer_print_qr_code ( printer_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // PRINTER_H
 // printer
 
// ------------------------------------------------------------------------ END